API Documentation
StructToString.h
1 // StructToString.h
3 //
5 
6 namespace nkGraphics
7 {
13  class DLL_GRAPHICS_EXPORT StructToString
14  {
15  public :
16 
17  // Shader types
24  static const char* getShaderTypeString (SHADER_TYPE val) ;
31  static SHADER_TYPE getStringShaderType (const std::string_view& str) ;
32 
33  // Shader semantics
40  static const char* getShaderSemanticString (SHADER_SEMANTIC val) ;
47  static SHADER_SEMANTIC getStringShaderSemantic (const char* str) ;
48 
49  // Program profile
63  static PROGRAM_COMPILATION_PROFILE getStringProgramProfile (const std::string_view& str) ;
64 
65  // Blend
72  static const char* getBlendString (BLEND val) ;
79  static BLEND getStringBlend (const std::string_view& str) ;
86  static BLEND getBlendFromIndex (unsigned int index) ;
87 
88  // Blend Op
95  static const char* getBlendOpString (BLEND_OP val) ;
102  static BLEND_OP getStringBlendOp (const std::string_view& str) ;
109  static BLEND_OP getBlendOpFromIndex (unsigned int index) ;
110 
111  // Write mask
118  static const char* getWriteMaskString (COLOR_WRITE_ENABLE val) ;
125  static COLOR_WRITE_ENABLE getStringWriteMask (const std::string_view& str) ;
132  static COLOR_WRITE_ENABLE getWriteMaskFromIndex (unsigned int index) ;
133 
134  // Comparison func
141  static const char* getComparisonFuncString (COMPARISON_FUNC val) ;
148  static COMPARISON_FUNC getStringComparisonFunc (const std::string_view& str) ;
155  static COMPARISON_FUNC getComparisonFuncFromIndex (unsigned int index) ;
156 
157  // Depth write mask
164  static const char* getDepthWriteMaskString (DEPTH_WRITE_MASK val) ;
171  static DEPTH_WRITE_MASK getStringDepthWriteMask (const std::string_view& str) ;
178  static DEPTH_WRITE_MASK getDepthWriteMaskFromIndex (unsigned int index) ;
179 
180  // Stencil op
187  static const char* getStencilOpString (STENCIL_OP val) ;
194  static STENCIL_OP getStringStencilOp (const std::string_view& str) ;
201  static STENCIL_OP getStencilOpFromIndex (unsigned int index) ;
202 
203  // Fill mode
210  static const char* getFillModeString (FILL_MODE val) ;
217  static FILL_MODE getStringFillMode (const std::string_view& str) ;
224  static FILL_MODE getFillModeFromIndex (unsigned int index) ;
225 
226  // Cull Mode
233  static const char* getCullModeString (CULL_MODE val) ;
240  static CULL_MODE getStringCullMode (const std::string_view& str) ;
247  static CULL_MODE getCullModeFromIndex (unsigned int index) ;
248 
249  // Address Mode
256  static const char* getAddressModeString (TEXTURE_ADDRESS_MODE val) ;
263  static TEXTURE_ADDRESS_MODE getStringAddressMode (const std::string_view& str) ;
270  static TEXTURE_ADDRESS_MODE getAddressModeFromIndex (unsigned int index) ;
271 
272  // Filter
279  static const char* getFilteringString (FILTER val) ;
286  static FILTER getStringFiltering (const std::string_view& str) ;
293  static FILTER getFilteringFromIndex (unsigned int index) ;
294 
295  // Usage
302  static const char* getUsageString (USAGE val) ;
309  static USAGE getStringUsage (const char* str) ;
316  static USAGE getUsageFromIndex (unsigned int index) ;
317 
318  // Format
325  static const char* getFormatString (FORMAT val) ;
332  static FORMAT getStringFormat (const std::string_view& str) ;
339  static FORMAT getFormatFromIndex (unsigned int index) ;
340 
341  // Bind Flag
348  static const char* getBindFlagString (BIND_FLAG val) ;
355  static BIND_FLAG getStringBindFlag (const char* str) ;
362  static BIND_FLAG getBindFlagFromIndex (unsigned int index) ;
363 
364  // CPU Access Flag
371  static const char* getCpuAccessFlagString (CPU_ACCESS_FLAG val) ;
378  static CPU_ACCESS_FLAG getStringCpuAccessFlag (const char* str) ;
385  static CPU_ACCESS_FLAG getCpuAccessFlagFromIndex (unsigned int index) ;
386 
387  // Misc Flags
394  static const char* getMiscFlagString (RESOURCE_MISC_FLAG val) ;
401  static RESOURCE_MISC_FLAG getStringMiscFlag (const char* str) ;
408  static RESOURCE_MISC_FLAG getMiscFlagFromIndex (unsigned int index) ;
409 
410  // Pass type
417  static const char* getPassTypeString (PASS_TYPE val) ;
424  static PASS_TYPE getStringPassType (const char* str) ;
425 
426  // Resource type
433  static const char* getResourceTypeString (RESOURCE_TYPE val) ;
440  static RESOURCE_TYPE getStringResourceType (const char* str) ;
441 
442  // Texture render flag
449  static std::string_view getTexRenderFlagString (TEX_RENDER_FLAG val) ;
456  static TEX_RENDER_FLAG getStringTexRenderFlag (const std::string_view& str) ;
457  } ;
458 }
nkGraphics::CULL_MODE
CULL_MODE
Available culling modes.
Definition: DxDefinesWrapper.h:500
nkGraphics::RESOURCE_MISC_FLAG
RESOURCE_MISC_FLAG
Available misc flags for resources.
Definition: DxDefinesWrapper.h:56
nkGraphics::StructToString::getStringDepthWriteMask
static DEPTH_WRITE_MASK getStringDepthWriteMask(const std::string_view &str)
nkGraphics::BLEND_OP
BLEND_OP
Available blending operations.
Definition: DxDefinesWrapper.h:464
nkGraphics::StructToString::getDepthWriteMaskString
static const char * getDepthWriteMaskString(DEPTH_WRITE_MASK val)
nkGraphics::StructToString::getStencilOpString
static const char * getStencilOpString(STENCIL_OP val)
nkGraphics::StructToString::getUsageString
static const char * getUsageString(USAGE val)
nkGraphics::StructToString::getDepthWriteMaskFromIndex
static DEPTH_WRITE_MASK getDepthWriteMaskFromIndex(unsigned int index)
nkGraphics::StructToString::getStringPassType
static PASS_TYPE getStringPassType(const char *str)
nkGraphics::StructToString::getStringComparisonFunc
static COMPARISON_FUNC getStringComparisonFunc(const std::string_view &str)
nkGraphics::StructToString::getBindFlagString
static const char * getBindFlagString(BIND_FLAG val)
nkGraphics::RESOURCE_TYPE
RESOURCE_TYPE
The type of resources available in the component.
Definition: ResourceType.h:12
nkGraphics::SHADER_TYPE
SHADER_TYPE
Available shader types.
Definition: DxDefinesWrapper.h:511
nkGraphics::BIND_FLAG
BIND_FLAG
Available binding flags for a resources.
Definition: DxDefinesWrapper.h:25
nkGraphics::StructToString
Converts enums to string, and vice versa.
Definition: StructToString.h:14
nkGraphics::StructToString::getStencilOpFromIndex
static STENCIL_OP getStencilOpFromIndex(unsigned int index)
nkGraphics::StructToString::getCullModeString
static const char * getCullModeString(CULL_MODE val)
nkGraphics::StructToString::getFilteringString
static const char * getFilteringString(FILTER val)
nkGraphics::StructToString::getComparisonFuncFromIndex
static COMPARISON_FUNC getComparisonFuncFromIndex(unsigned int index)
nkGraphics::StructToString::getStringUsage
static USAGE getStringUsage(const char *str)
nkGraphics::StructToString::getComparisonFuncString
static const char * getComparisonFuncString(COMPARISON_FUNC val)
nkGraphics::StructToString::getCpuAccessFlagFromIndex
static CPU_ACCESS_FLAG getCpuAccessFlagFromIndex(unsigned int index)
nkGraphics::StructToString::getBlendOpFromIndex
static BLEND_OP getBlendOpFromIndex(unsigned int index)
nkGraphics::StructToString::getShaderTypeString
static const char * getShaderTypeString(SHADER_TYPE val)
nkGraphics::StructToString::getBlendFromIndex
static BLEND getBlendFromIndex(unsigned int index)
nkGraphics::StructToString::getFillModeString
static const char * getFillModeString(FILL_MODE val)
nkGraphics::StructToString::getFillModeFromIndex
static FILL_MODE getFillModeFromIndex(unsigned int index)
nkGraphics::StructToString::getCullModeFromIndex
static CULL_MODE getCullModeFromIndex(unsigned int index)
nkGraphics::StructToString::getShaderSemanticString
static const char * getShaderSemanticString(SHADER_SEMANTIC val)
nkGraphics::StructToString::getAddressModeFromIndex
static TEXTURE_ADDRESS_MODE getAddressModeFromIndex(unsigned int index)
nkGraphics::DEPTH_WRITE_MASK
DEPTH_WRITE_MASK
Available depth write masks.
Definition: DxDefinesWrapper.h:266
nkGraphics::USAGE
USAGE
Available usage for resources. Drives the memory used for hosting the data.
Definition: DxDefinesWrapper.h:13
nkGraphics::StructToString::getWriteMaskFromIndex
static COLOR_WRITE_ENABLE getWriteMaskFromIndex(unsigned int index)
nkGraphics::StructToString::getStringBindFlag
static BIND_FLAG getStringBindFlag(const char *str)
nkGraphics::StructToString::getStringCpuAccessFlag
static CPU_ACCESS_FLAG getStringCpuAccessFlag(const char *str)
nkGraphics::StructToString::getStringBlend
static BLEND getStringBlend(const std::string_view &str)
nkGraphics::StructToString::getMiscFlagFromIndex
static RESOURCE_MISC_FLAG getMiscFlagFromIndex(unsigned int index)
nkGraphics::StructToString::getBlendOpString
static const char * getBlendOpString(BLEND_OP val)
nkGraphics::StructToString::getStringShaderType
static SHADER_TYPE getStringShaderType(const std::string_view &str)
nkGraphics::StructToString::getCpuAccessFlagString
static const char * getCpuAccessFlagString(CPU_ACCESS_FLAG val)
nkGraphics::COLOR_WRITE_ENABLE
COLOR_WRITE_ENABLE
Available color write masks.
Definition: DxDefinesWrapper.h:477
nkGraphics::BLEND
BLEND
Available blending types.
Definition: DxDefinesWrapper.h:439
nkGraphics::StructToString::getStringWriteMask
static COLOR_WRITE_ENABLE getStringWriteMask(const std::string_view &str)
nkGraphics::StructToString::getStringFormat
static FORMAT getStringFormat(const std::string_view &str)
nkGraphics::StructToString::getBlendString
static const char * getBlendString(BLEND val)
nkGraphics::StructToString::getFormatString
static const char * getFormatString(FORMAT val)
nkGraphics::PASS_TYPE
PASS_TYPE
The pass types available in the component.
Definition: PassType.h:12
nkGraphics::StructToString::getUsageFromIndex
static USAGE getUsageFromIndex(unsigned int index)
nkGraphics::CPU_ACCESS_FLAG
CPU_ACCESS_FLAG
Available cpu access flags.
Definition: DxDefinesWrapper.h:44
nkGraphics::StructToString::getStringShaderSemantic
static SHADER_SEMANTIC getStringShaderSemantic(const char *str)
nkGraphics::StructToString::getStringResourceType
static RESOURCE_TYPE getStringResourceType(const char *str)
nkGraphics::StructToString::getStringMiscFlag
static RESOURCE_MISC_FLAG getStringMiscFlag(const char *str)
nkGraphics::StructToString::getStringAddressMode
static TEXTURE_ADDRESS_MODE getStringAddressMode(const std::string_view &str)
nkGraphics::StructToString::getStringProgramProfile
static PROGRAM_COMPILATION_PROFILE getStringProgramProfile(const std::string_view &str)
nkGraphics::StructToString::getStringTexRenderFlag
static TEX_RENDER_FLAG getStringTexRenderFlag(const std::string_view &str)
nkGraphics::TEXTURE_ADDRESS_MODE
TEXTURE_ADDRESS_MODE
Available texture addressing modes available for samplers.
Definition: DxDefinesWrapper.h:126
nkGraphics::StructToString::getFilteringFromIndex
static FILTER getFilteringFromIndex(unsigned int index)
nkGraphics::FILTER
FILTER
Available filters available for samplers.
Definition: DxDefinesWrapper.h:82
nkGraphics::StructToString::getResourceTypeString
static const char * getResourceTypeString(RESOURCE_TYPE val)
nkGraphics::SHADER_SEMANTIC
SHADER_SEMANTIC
Available shader semantics.
Definition: DxDefinesWrapper.h:527
nkGraphics::COMPARISON_FUNC
COMPARISON_FUNC
Available comparison functions.
Definition: DxDefinesWrapper.h:139
nkGraphics::STENCIL_OP
STENCIL_OP
Available stencil operations.
Definition: DxDefinesWrapper.h:276
nkGraphics::StructToString::getMiscFlagString
static const char * getMiscFlagString(RESOURCE_MISC_FLAG val)
nkGraphics::StructToString::getStringBlendOp
static BLEND_OP getStringBlendOp(const std::string_view &str)
nkGraphics::FORMAT
FORMAT
Available formats for resources.
Definition: DxDefinesWrapper.h:155
nkGraphics::StructToString::getFormatFromIndex
static FORMAT getFormatFromIndex(unsigned int index)
nkGraphics::FILL_MODE
FILL_MODE
Available filling mode during rasterization.
Definition: DxDefinesWrapper.h:490
nkGraphics::StructToString::getStringStencilOp
static STENCIL_OP getStringStencilOp(const std::string_view &str)
nkGraphics::StructToString::getAddressModeString
static const char * getAddressModeString(TEXTURE_ADDRESS_MODE val)
nkGraphics::StructToString::getBindFlagFromIndex
static BIND_FLAG getBindFlagFromIndex(unsigned int index)
nkGraphics::StructToString::getPassTypeString
static const char * getPassTypeString(PASS_TYPE val)
nkGraphics::PROGRAM_COMPILATION_PROFILE
PROGRAM_COMPILATION_PROFILE
Available program compilation profiles.
Definition: DxDefinesWrapper.h:652
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::StructToString::getStringFillMode
static FILL_MODE getStringFillMode(const std::string_view &str)
nkGraphics::StructToString::getProgramProfileString
static const char * getProgramProfileString(PROGRAM_COMPILATION_PROFILE val)
nkGraphics::StructToString::getStringFiltering
static FILTER getStringFiltering(const std::string_view &str)
nkGraphics::StructToString::getStringCullMode
static CULL_MODE getStringCullMode(const std::string_view &str)
nkGraphics::TEX_RENDER_FLAG
TEX_RENDER_FLAG
The render flag possible for a texture.
Definition: Texture.h:22
nkGraphics::StructToString::getTexRenderFlagString
static std::string_view getTexRenderFlagString(TEX_RENDER_FLAG val)
nkGraphics::StructToString::getWriteMaskString
static const char * getWriteMaskString(COLOR_WRITE_ENABLE val)